.. _cmsHomeMoveAllStart:

cmsHomeMoveAllStart 
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

    VT_I4 cmsHomeMoveAllStart([in] VT_I4 BoardID, [in] VT_I4 NumAxes, [in] VT_PI4 AxisList)            

DESCRIPTION
`````````````  

- 여러 축에 대한 원점복귀 작업을 동시에 수행합니다. cmsHomeMoveAll() 함수는 모션이 
  완료되기 전까지 반환되지 않으며, cmsHomeMoveAllStart() 함수는 모션을 시작시킨 후에 바로 
  반환됩니다.     

\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cms 가 붙지 않습니다.


PARAMETER
`````````````

▶ BoardId: 사용자가 설정한 디바이스(보드) ID. 
 
▶ NumAxes : 동시에 작업을 수행할 대상 축의 수 
 
▶ AxisList : 동시에 작업을 수행할 대상 축의 배열 주소값. 이 배열의 크기는 NumAxes값과 
일치하거나 커야 합니다.  
 
▶ IsBlocking : 완료될 때까지 기다리는 동안 윈도우 메시지를 블록(Blocking)할 것인지를 
결정합니다.  

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    "| 0 또는 cmsFALSE", "
     |                     블록(Blocking)을 하지 않습니다. 따라서 해당 모션이 
     |                     완료되는 동안에도 윈도우 이벤트를 처리합니다."
    "| 1 또는 cmsTRUE","
     |                  블록(Blocking)을 합니다. 따라서 해당 모션이 완료되는 
     |                  동안에는 윈도우 이벤트가 처리되지 않습니다."    

RETURN VALUE
`````````````

+------------+-----------+
|    Value   | Meaning   |
+============+===========+
|    음수    | 수행 실패 |
+------------+-----------+
| ERR_NONE   | 수행 성공 |
+------------+-----------+

REFERENCE
```````````````

- cmsHomeMoveAllStart() 함수를 사용하는 경우에는 cmsMxIsDone() 함수나 MxWaitDone() 
  함수를 사용하여 모션의 완료를 확인(確認)할 수 있습니다. 

\

- cmsHomeMoveAll() 함수를 사용하는 경우에는 내부적으로 루프를 수행하면서 모션이 
  완료되기를 기다리는데, 이때 “Blocking Mode”의 전달 인자값에 따라 윈도우 이벤트를 
  처리하는 방식이 달라집니다.  

\

- INP 입력신호가 Enable로 설정되었으면 Command 펄스 출력이 완료되어도 INP 입력이 
  ON이 되기 전까지는 모션이 완료되지 않은 것으로 간주되어 반환되지 않습니다.   

.. note:: "윈도우 이벤트란느 것은 무엇입니까?"
    윈도우 운영체제는 Event Driven 혹은 Message Driven 방식의 구조로 
    되어 있습니다. 각 응용프로그램은 메시지 큐(Queue)를 가지고 
    있으며, 정확히 말하면, 메시지를 사용해 이벤트를 통지하는 
    방식으로 설계되어 있습니다. 윈도우 메시지를 처리한다는 것은 
    메시지 큐에서 메시지를 하나씩 꺼내서 윈도우 프로시저에 
    전송한다는 것을 의미하며, 이것은 그 행선지가 되는 윈도우에 
    전송되어 처리됩니다. 

EXAMPLE
```````````

- 본 예제는 cmsHomeMoveAll() 함수를 이용하여 X1, Y1 축의 원점복귀를 동시에 수행하는 
  함수입니다. 

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

    C/C++  
    #Define DEV0 
    0 
    #include "ComiSSCNET3_SDK.h" 
    #include "ComiSSCNET3_SDK_Def.h" 
    /*************************************************************** 
    * OnHomeSetSpeed :  이 함수는 속도설정의 변경이 필요할 때  
    * 호출되는 가상의 함수 입니다. 이때 m_fVwork, m_fAcc, m_fDec 변수를  
    * 통하여 속도, 가속도 , 감속도 값이 적절하게 전달된다고 가정합니다.  
    **************************************************************/ 
    void OnHomeSetSpeed() 
    { 
    //각 축(Axis)의 기본 속도를 설정 합니다. 
    //X1축의 홈복귀 모드를 설정합니다.  
    cmsHomeSetConfig(DEV0, 0, 0, 1, 100, 10);  
    //Y1축의 홈복귀 모드를 설정합니다.  
    cmsHomeSetConfig(DEV0, cmsY1, 0, 1, 100, 10);  
    // X1축 홈복귀 속도패턴 설정 // 
    cmsHomeSetSpeedPattern(DEV0, 0, cmsSMODE_S, m_fVwork, m_fAcc, m_fDec, 
    m_fRevVel );  
    // Y1축 홈복귀 속도패턴 설정 // 
    cmsHomeSetSpeedPattern(DEV0, cmsY1, cmsSMODE_S, m_fVwork, m_fAcc, m_fDec, 
    m_fRevVel );  
    } 
    
    /*************************************************************** 
    * OnHomeReturn : 이 함수는 가상의 함수로서  원점복귀를 실행합니다. 
    **************************************************************/ 
    void OnHomeReturn() 
    { 
    long nAxes[2] = {0, cmsY1}; 
    long nDirList[2] = {cmsDIR_N, cmsDIR_N}; 
    
    if(cmsHomeMoveAll(DEV0, 2, nAxes, nDirList, cmsFALSE) != ERR_NONE){ 
    // 에러메시지 출력 
    return ; 
    } 
    ///////////////////////////////////////////////////////////// 
    // cmsHomeMoveAll() 함수 대신 아래와 같이 cmsHomeMoveAllStart() 함 
    // 수를 사용할 수 있습니다. 
    // cmsHomeMoveAllStart(DEV0, 2, nAxes, nDirList, cmsFALSE); 
    // cmsMxWaitDone(DEV0, 2, nAxes, cmsFALSE); 
    } 
    
    -------------------------------------------------------------------------------------

    Visual Basic 
 
    Const DEV0 = 0 
    
    ' 홈복귀를 위한 가상 함수를 시작합니다. 
    Private Sub OnStart() 
    
        Dim AxisList(2) As Long 
        Dim DirList(2) As Long 
        
        AxisList(0) = 0 
        AxisList(1) = cmsY1 
        
        DirList(0) = cmsDIR_N 
        DirList(1) = cmsDIR_N 
        
    
        ' HomeSetConfig( 디바이스 ID, 대상 축, 홈 복귀 모드, EZCount, EscDist, Offset ) 
        Call HomeSetConfig(DEV0, AxisList(0), 0, 0, 1000, 0) 
        Call HomeSetConfig(DEV0, AxisList(1), 0, 0, 1000, 0) 
        
        ' HomeSetSpeedPattern 함수를 통해 원점 복귀 속도를 결정합니다. 
        Call HomeSetSpeedPattern(DEV0, AxisList(0), cmsSMODE_S, 10000, 20000, 20000, 1000) 
        Call HomeSetSpeedPattern(DEV0, AxisList(1), cmsSMODE_S, 10000, 20000, 20000, 1000) 
    
        ' HomeMoveAll(대상 축, 홈 복귀 방향, 블록킹 여부) 
        Call HomeMoveAll(DEV0, 2,AxisList(0),DirList(0), cmsFALSE) 
        
    End Sub

    -------------------------------------------------------------------------------------

    Delphi 
 
    procedure btnHomeMoveClick(); 
    var 
        arAxes : Array[0..1] of LongInt; 
        arDirecton : Array[0..1] of LongInt; 
    begin 
    
        // cmsHomeSetConfig( 디바이스 ID, 대상 축, 홈 복귀 모드, EZCount, EscDist, Offset ); 
        
        // X1 축 에 대한 홈 설정을 합니다. 
        cmsHomeSetConfig(0, 0, 0, 0, 1000, 0 ); 
    
        // Y1 축에 대한 홈 설정을 합니다. 
        cmsHomeSetConfig(0, cmsY1, 0, 0, 1000, 0 ); 
    
        // X1 축의 홈 복귀 속도를 설정합니다. 
        cmsHomeSetSpeedPattern( 
    0, 
            0, 
            cmsSMODE_S, 
            10000, 
            20000, 
            20000, 
            1000); 
    
        // Y1 축의 홈 복귀 속도를 설정합니다. 
        cmsHomeSetSpeedPattern( 
    0, 
            cmsY1, 
            cmsSMODE_S, 
            10000, 
            20000, 
            20000, 
            1000); 
    
        //  다축의 홈 이송을 시작합니다. 각 축의 홈 복귀 방향은 Negative 로 설정합니다 
        arAxes[0] := 0;              // X1 축 
        arAxes[1] := cmsY1;              // Y1 축  
        arDirecton[0] := cmsDIR_N; 
        arDirecton[1] := cmsDIR_N; 
    
        // 인자는 다음과 같습니다. 
        // cmsHomeMoveAllStart( 디바이스 ID, 홈복귀 대상축, 축의 배열, 방향의 배열) 
        // 이 명령은 홈 복귀 명령 실행시 바로 리턴됩니다. 
        cmsHomeMoveAllStart(0, 2, @arAxes, @arDirecton); 
    
        // 두 축에 대해서 홈 복귀 완료시까지 대기합니다. 
        cmsHomeWaitDone(0, 0, cmsFALSE); 
        cmsHomeWaitDone(0, cmsY1, cmsFALSE); 
    end; 
    
    end. 

    -------------------------------------------------------------------------------------